<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Summary of run-time parameters</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../index.html" title="Boost.Test">
<link rel="up" href="../runtime_config.html" title="Runtime parameters">
<link rel="prev" href="custom_command_line_arguments.html" title="Custom command line arguments">
<link rel="next" href="../adv_scenarios.html" title="Advanced Usage Scenarios">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="custom_command_line_arguments.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../runtime_config.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../adv_scenarios.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_test.runtime_config.summary"></a><a class="link" href="summary.html" title="Summary of run-time parameters">Summary of run-time
      parameters</a>
</h3></div></div></div>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                <p>
                  Command
                </p>
              </th>
<th>
                <p>
                  Short description
                </p>
              </th>
</tr></thead>
<tbody>
<tr>
<td>
                <p>
                  <a class="link" href="../utf_reference/rt_param_reference/auto_dbg.html" title="auto_start_dbg"><code class="computeroutput"><span class="identifier">auto_start_dbg</span></code></a>
                </p>
              </td>
<td>
                <p>
                  Instructs the framework to automatically attach debugger in case
                  of system failure.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="../utf_reference/rt_param_reference/build_info.html" title="build_info"><code class="computeroutput"><span class="identifier">build_info</span></code></a>
                </p>
              </td>
<td>
                <p>
                  Instructs the framework to display library build information.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="../utf_reference/rt_param_reference/catch_system.html" title="catch_system_errors"><code class="computeroutput"><span class="identifier">catch_system_error</span></code></a>
                </p>
              </td>
<td>
                <p>
                  Instructs the framework to catch system errors.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="../utf_reference/rt_param_reference/color_output.html" title="color_output"><code class="computeroutput"><span class="identifier">color_output</span></code></a>
                </p>
              </td>
<td>
                <p>
                  Instructs the framework to produce color output
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="../utf_reference/rt_param_reference/detect_fp_exceptions.html" title="detect_fp_exceptions"><code class="computeroutput"><span class="identifier">detect_fp_exceptions</span></code></a>
                </p>
              </td>
<td>
                <p>
                  Instructs the framework to trap floating point exceptions (on supported
                  platforms).
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="../utf_reference/rt_param_reference/detect_memory_leaks.html" title="detect_memory_leaks"><code class="computeroutput"><span class="identifier">detect_memory_leaks</span></code></a>
                </p>
              </td>
<td>
                <p>
                  Instructs the framework to detect memory leaks (on supported platforms).
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="../utf_reference/rt_param_reference/help.html" title="help"><code class="computeroutput"><span class="identifier">help</span></code></a>
                </p>
              </td>
<td>
                <p>
                  Provides help on the <span class="emphasis"><em>Unit Test Framework</em></span> parameters.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="../utf_reference/rt_param_reference/list_content.html" title="list_content"><code class="computeroutput"><span class="identifier">list_content</span></code></a>
                </p>
              </td>
<td>
                <p>
                  Lists the tests units, their organization in the test tree, their
                  enabled/disabled state...
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="../utf_reference/rt_param_reference/list_labels.html" title="list_labels"><code class="computeroutput"><span class="identifier">list_labels</span></code></a>
                </p>
              </td>
<td>
                <p>
                  Lists the labels defined in the test module.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="../utf_reference/rt_param_reference/log_format.html" title="log_format"><code class="computeroutput"><span class="identifier">log_format</span></code></a>
                </p>
              </td>
<td>
                <p>
                  Specifies the log format
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="../utf_reference/rt_param_reference/log_level.html" title="log_level"><code class="computeroutput"><span class="identifier">log_level</span></code></a>
                </p>
              </td>
<td>
                <p>
                  Specifies the framework's logging level
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="../utf_reference/rt_param_reference/log_sink.html" title="log_sink"><code class="computeroutput"><span class="identifier">log_sink</span></code></a>
                </p>
              </td>
<td>
                <p>
                  Specifies where to write testing log to.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="../utf_reference/rt_param_reference/logger.html" title="logger"><code class="computeroutput"><span class="identifier">logger</span></code></a>
                </p>
              </td>
<td>
                <p>
                  Specifies the log level, format and sink of one or more loggers.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="../utf_reference/rt_param_reference/output_format.html" title="output_format"><code class="computeroutput"><span class="identifier">output_format</span></code></a>
                </p>
              </td>
<td>
                <p>
                  Specifies the log format and the report format.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="../utf_reference/rt_param_reference/random.html" title="random"><code class="computeroutput"><span class="identifier">random</span></code></a>
                </p>
              </td>
<td>
                <p>
                  Instructs the framework to run the tests in random order
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="../utf_reference/rt_param_reference/report_format.html" title="report_format"><code class="computeroutput"><span class="identifier">report_format</span></code></a>
                </p>
              </td>
<td>
                <p>
                  Specifies the report format.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="../utf_reference/rt_param_reference/report_level.html" title="report_level"><code class="computeroutput"><span class="identifier">report_level</span></code></a>
                </p>
              </td>
<td>
                <p>
                  Specifies the level of details carried by the framework's testing
                  result report.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="../utf_reference/rt_param_reference/report_memory_leaks_to.html" title="report_memory_leaks_to"><code class="computeroutput"><span class="identifier">report_memory_leaks_to</span></code></a>
                </p>
              </td>
<td>
                <p>
                  Specifies file name where memory leaks report should be re-directed
                  to.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="../utf_reference/rt_param_reference/report_sink.html" title="report_sink"><code class="computeroutput"><span class="identifier">report_sink</span></code></a>
                </p>
              </td>
<td>
                <p>
                  Specifies where to write the testing result report to.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="../utf_reference/rt_param_reference/result_code.html" title="result_code"><code class="computeroutput"><span class="identifier">result_code</span></code></a>
                </p>
              </td>
<td>
                <p>
                  Instructs the framework to return or ignore a result code indicating
                  an error in the tests.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="../utf_reference/rt_param_reference/run_test.html" title="run_test"><code class="computeroutput"><span class="identifier">run_test</span></code></a>
                </p>
              </td>
<td>
                <p>
                  Allows to filter which test units to execute at runtime.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="../utf_reference/rt_param_reference/save_pattern.html" title="save_pattern"><code class="computeroutput"><span class="identifier">save_pattern</span></code></a>
                </p>
              </td>
<td>
                <p>
                  Facilitates mode switching for testing output streams.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="../utf_reference/rt_param_reference/show_progress.html" title="show_progress"><code class="computeroutput"><span class="identifier">show_progress</span></code></a>
                </p>
              </td>
<td>
                <p>
                  Instructs the framework to print progress information. More details
                  <a class="link" href="../test_output/test_output_progress.html" title="Progress display">here</a>.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="../utf_reference/rt_param_reference/use_alt_stack.html" title="use_alt_stack"><code class="computeroutput"><span class="identifier">use_alt_stack</span></code></a>
                </p>
              </td>
<td>
                <p>
                  Instructs the framework to use an alternative stack for signal
                  processing (on supported platforms).
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="../utf_reference/rt_param_reference/usage.html" title="usage"><code class="computeroutput"><span class="identifier">usage</span></code></a>
                </p>
              </td>
<td>
                <p>
                  Displays short usage message.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="../utf_reference/rt_param_reference/wait_for_debugger.html" title="wait_for_debugger"><code class="computeroutput"><span class="identifier">wait_for_debugger</span></code></a>
                </p>
              </td>
<td>
                <p>
                  Instructs the framework to pause test module before testing is
                  started to allow debugger to attach.
                </p>
              </td>
</tr>
</tbody>
</table></div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2001-2020 Boost.Test contributors<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="custom_command_line_arguments.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../runtime_config.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../adv_scenarios.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
